Compose Native Tray Library/com.kdroid.composetray.tray.api

Package-level declarations

Types

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.TYPEALIAS])
annotation class ExperimentalTrayAppApi

Marks the TrayApp API as experimental. This API is subject to change and may be modified or removed in future releases without prior notice.

Link copied to clipboard
class TrayAppState(initialWindowSize: <Error class: unknown class> = DpSize(300.dp, 200.dp), initiallyVisible: Boolean = false, initialDismissMode: TrayWindowDismissMode = TrayWindowDismissMode.AUTO)

State holder for TrayApp that provides programmatic control over the tray window and observability of its state changes, including window dismiss behavior.

Link copied to clipboard
enum TrayWindowDismissMode : Enum<TrayWindowDismissMode>

Defines how the tray window should be dismissed (hidden)

Functions

Link copied to clipboard
fun rememberTrayAppState(initialWindowSize: <Error class: unknown class> = DpSize(300.dp, 200.dp), initiallyVisible: Boolean = false, initialDismissMode: TrayWindowDismissMode = TrayWindowDismissMode.AUTO): TrayAppState

Creates and remembers a TrayAppState instance

Link copied to clipboard
fun <Error class: unknown class>.Tray(icon: <Error class: unknown class>, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, primaryAction: () -> Unit? = null, menuContent: TrayMenuBuilder.() -> Unit? = null)

DrawableResource helpers

fun <Error class: unknown class>.Tray(icon: <Error class: unknown class>, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, primaryAction: () -> Unit? = null, menuContent: TrayMenuBuilder.() -> Unit? = null)
fun <Error class: unknown class>.Tray(iconContent: () -> Unit, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, primaryAction: () -> Unit? = null, menuContent: TrayMenuBuilder.() -> Unit? = null)
fun <Error class: unknown class>.Tray(icon: <Error class: unknown class>, tint: <Error class: unknown class>? = null, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, primaryAction: () -> Unit? = null, menuContent: TrayMenuBuilder.() -> Unit? = null)
fun <Error class: unknown class>.Tray(windowsIcon: <Error class: unknown class>, macLinuxIcon: <Error class: unknown class>, tint: <Error class: unknown class>? = null, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, primaryAction: () -> Unit? = null, menuContent: TrayMenuBuilder.() -> Unit? = null)

fun <Error class: unknown class>.Tray(iconPath: String, windowsIconPath: String = iconPath, tooltip: String, primaryAction: () -> Unit? = null, menuContent: TrayMenuBuilder.() -> Unit? = null)

Composable helpers

fun <Error class: unknown class>.Tray(windowsIcon: <Error class: unknown class>, macLinuxIcon: <Error class: unknown class>, tint: <Error class: unknown class>? = null, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, primaryAction: () -> Unit? = null, menuContent: TrayMenuBuilder.() -> Unit? = null)

Platform-polymorphic helper

Link copied to clipboard
fun <Error class: unknown class>.TrayApp(icon: <Error class: unknown class>, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, state: TrayAppState? = null, windowSize: <Error class: unknown class>? = null, visibleOnStart: Boolean = false, enterTransition: <Error class: unknown class> = defaultTrayAppEnterTransition, exitTransition: <Error class: unknown class> = defaultTrayAppExitTransition, transparent: Boolean = true, windowsTitle: String = "", windowIcon: <Error class: unknown class>? = null, undecorated: Boolean = true, resizable: Boolean = false, horizontalOffset: Int = 0, verticalOffset: Int = defaultVerticalOffset, onPreviewKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, onKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, menu: TrayMenuBuilder.() -> Unit? = null, content: <Error class: unknown class>.() -> Unit)
fun <Error class: unknown class>.TrayApp(icon: <Error class: unknown class>, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, state: TrayAppState? = null, windowSize: <Error class: unknown class>? = null, visibleOnStart: Boolean = false, enterTransition: <Error class: unknown class> = defaultTrayAppEnterTransition, exitTransition: <Error class: unknown class> = defaultTrayAppExitTransition, transparent: Boolean = true, windowsTitle: String = "", windowIcon: <Error class: unknown class>? = null, undecorated: Boolean = true, resizable: Boolean = false, horizontalOffset: Int = 0, verticalOffset: Int = defaultVerticalOffset, onPreviewKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, onKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, menu: TrayMenuBuilder.() -> Unit? = null, content: <Error class: unknown class>.() -> Unit)
fun <Error class: unknown class>.TrayApp(iconContent: () -> Unit, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, state: TrayAppState? = null, windowSize: <Error class: unknown class>? = null, visibleOnStart: Boolean = false, enterTransition: <Error class: unknown class> = defaultTrayAppEnterTransition, exitTransition: <Error class: unknown class> = defaultTrayAppExitTransition, transparent: Boolean = true, windowsTitle: String = "", windowIcon: <Error class: unknown class>? = null, undecorated: Boolean = true, resizable: Boolean = false, horizontalOffset: Int = 0, verticalOffset: Int = defaultVerticalOffset, onPreviewKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, onKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, menu: TrayMenuBuilder.() -> Unit? = null, content: <Error class: unknown class>.() -> Unit)
fun <Error class: unknown class>.TrayApp(icon: <Error class: unknown class>, tint: <Error class: unknown class>? = null, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, state: TrayAppState? = null, windowSize: <Error class: unknown class>? = null, visibleOnStart: Boolean = false, enterTransition: <Error class: unknown class> = defaultTrayAppEnterTransition, exitTransition: <Error class: unknown class> = defaultTrayAppExitTransition, transparent: Boolean = true, windowsTitle: String = "", windowIcon: <Error class: unknown class>? = null, undecorated: Boolean = true, resizable: Boolean = false, horizontalOffset: Int = 0, verticalOffset: Int = defaultVerticalOffset, onPreviewKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, onKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, menu: TrayMenuBuilder.() -> Unit? = null, content: <Error class: unknown class>.() -> Unit)
fun <Error class: unknown class>.TrayApp(windowsIcon: <Error class: unknown class>, macLinuxIcon: <Error class: unknown class>, tint: <Error class: unknown class>? = null, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, state: TrayAppState? = null, windowSize: <Error class: unknown class>? = null, visibleOnStart: Boolean = false, enterTransition: <Error class: unknown class> = defaultTrayAppEnterTransition, exitTransition: <Error class: unknown class> = defaultTrayAppExitTransition, transparent: Boolean = true, windowsTitle: String = "", windowIcon: <Error class: unknown class>? = null, undecorated: Boolean = true, resizable: Boolean = false, horizontalOffset: Int = 0, verticalOffset: Int = defaultVerticalOffset, onPreviewKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, onKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, menu: TrayMenuBuilder.() -> Unit? = null, content: <Error class: unknown class>.() -> Unit)

fun <Error class: unknown class>.TrayApp(windowsIcon: <Error class: unknown class>, macLinuxIcon: <Error class: unknown class>, tint: <Error class: unknown class>? = null, iconRenderProperties: IconRenderProperties = IconRenderProperties.forCurrentOperatingSystem(), tooltip: String, state: TrayAppState? = null, windowSize: <Error class: unknown class>? = null, visibleOnStart: Boolean = false, enterTransition: <Error class: unknown class> = defaultTrayAppEnterTransition, exitTransition: <Error class: unknown class> = defaultTrayAppExitTransition, transparent: Boolean = true, windowsTitle: String = "", windowIcon: <Error class: unknown class>? = null, undecorated: Boolean = true, resizable: Boolean = false, horizontalOffset: Int = 0, verticalOffset: Int = defaultVerticalOffset, onPreviewKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, onKeyEvent: (<Error class: unknown class>) -> Boolean = { false }, menu: TrayMenuBuilder.() -> Unit? = null, content: <Error class: unknown class>.() -> Unit)

Painter on Windows, ImageVector on macOS/Linux